<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.billingAccounts.html">billingAccounts</a> . <a href="discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html">billingAccountLicenseConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#distributeLicenseConfig">distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Distributes a LicenseConfig from billing account level to project level.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a BillingAccountLicenseConfig.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all BillingAccountLicenseConfigs for a given billing account.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#retractLicenseConfig">retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="distributeLicenseConfig">distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</code>
  <pre>Distributes a LicenseConfig from billing account level to project level.

Args:
  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for LicenseConfigService.DistributeLicenseConfig method.
  &quot;licenseConfigId&quot;: &quot;A String&quot;, # Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
  &quot;licenseCount&quot;: &quot;A String&quot;, # Required. The number of licenses to distribute.
  &quot;location&quot;: &quot;A String&quot;, # Required. The target GCP project region to distribute the license config to.
  &quot;projectNumber&quot;: &quot;A String&quot;, # Required. The target GCP project number to distribute the license config to.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for LicenseConfigService.DistributeLicenseConfig method.
  &quot;licenseConfig&quot;: { # Information about users&#x27; licenses. # The updated or created LicenseConfig.
    &quot;alertPolicyResourceConfig&quot;: { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
      &quot;alertEnrollments&quot;: [ # Optional. The enrollment state of each alert.
        { # The alert enrollment status.
          &quot;alertId&quot;: &quot;A String&quot;, # Immutable. The id of an alert.
          &quot;enrollState&quot;: &quot;A String&quot;, # Required. The enrollment status of a customer.
          &quot;notificationParams&quot;: { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
        },
      ],
      &quot;alertPolicy&quot;: &quot;A String&quot;, # Immutable. The fully qualified resource name of the AlertPolicy.
      &quot;contactDetails&quot;: [ # Optional. The contact details for each alert policy.
        { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
          &quot;emailAddress&quot;: &quot;A String&quot;, # Optional. The email address of the contact.
        },
      ],
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code used for notifications
    },
    &quot;autoRenew&quot;: True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
    &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
      &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
      &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
      &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    },
    &quot;freeTrial&quot;: True or False, # Optional. Whether the license config is for free trial.
    &quot;geminiBundle&quot;: True or False, # Output only. Whether the license config is for Gemini bundle.
    &quot;licenseCount&quot;: &quot;A String&quot;, # Required. Number of licenses purchased.
    &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
    &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
      &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
      &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
      &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    },
    &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the license config.
    &quot;subscriptionTerm&quot;: &quot;A String&quot;, # Required. Subscription term.
    &quot;subscriptionTier&quot;: &quot;A String&quot;, # Required. Subscription tier information for the license config.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a BillingAccountLicenseConfig.

Args:
  name: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about license configs at billing account level.
  &quot;autoRenew&quot;: True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
  &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed subscription end date.
    &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
    &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  &quot;geminiBundle&quot;: True or False, # Whether the license config is for Gemini bundle.
  &quot;licenseConfigDistributions&quot;: { # A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;licenseCount&quot;: &quot;A String&quot;, # Required. The number of licenses purchased under this billing account license config.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.
  &quot;procurementEntitlementId&quot;: &quot;A String&quot;, # The procurement entitlement id of the subscription.
  &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The subscription start date.
    &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
    &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the BillingAccountLicenseConfig.
  &quot;subscriptionDisplayName&quot;: &quot;A String&quot;, # The subscription display name.
  &quot;subscriptionName&quot;: &quot;A String&quot;, # Output only. The corresponding SubV3 subscription name.
  &quot;subscriptionTerm&quot;: &quot;A String&quot;, # Required. The subscription term.
  &quot;subscriptionTier&quot;: &quot;A String&quot;, # Required. The subscription tier.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all BillingAccountLicenseConfigs for a given billing account.

Args:
  parent: string, Required. Format: `billingAccounts/{billing_account}`. (required)
  pageSize: integer, Optional. Not supported.
  pageToken: string, Optional. Not supported.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.
  &quot;billingAccountLicenseConfigs&quot;: [ # All BillingAccountLicenseConfigs for the given billing account.
    { # Information about license configs at billing account level.
      &quot;autoRenew&quot;: True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
      &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed subscription end date.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;geminiBundle&quot;: True or False, # Whether the license config is for Gemini bundle.
      &quot;licenseConfigDistributions&quot;: { # A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;licenseCount&quot;: &quot;A String&quot;, # Required. The number of licenses purchased under this billing account license config.
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.
      &quot;procurementEntitlementId&quot;: &quot;A String&quot;, # The procurement entitlement id of the subscription.
      &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The subscription start date.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the BillingAccountLicenseConfig.
      &quot;subscriptionDisplayName&quot;: &quot;A String&quot;, # The subscription display name.
      &quot;subscriptionName&quot;: &quot;A String&quot;, # Output only. The corresponding SubV3 subscription name.
      &quot;subscriptionTerm&quot;: &quot;A String&quot;, # Required. The subscription term.
      &quot;subscriptionTier&quot;: &quot;A String&quot;, # Required. The subscription tier.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="retractLicenseConfig">retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</code>
  <pre>This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.

Args:
  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for LicenseConfigService.RetractLicenseConfig method.
  &quot;fullRetract&quot;: True or False, # Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
  &quot;licenseConfig&quot;: &quot;A String&quot;, # Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
  &quot;licenseCount&quot;: &quot;A String&quot;, # Optional. The number of licenses to retract. Only used when full_retract is false.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for LicenseConfigService.RetractLicenseConfig method.
  &quot;licenseConfig&quot;: { # Information about users&#x27; licenses. # The updated LicenseConfig.
    &quot;alertPolicyResourceConfig&quot;: { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
      &quot;alertEnrollments&quot;: [ # Optional. The enrollment state of each alert.
        { # The alert enrollment status.
          &quot;alertId&quot;: &quot;A String&quot;, # Immutable. The id of an alert.
          &quot;enrollState&quot;: &quot;A String&quot;, # Required. The enrollment status of a customer.
          &quot;notificationParams&quot;: { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
        },
      ],
      &quot;alertPolicy&quot;: &quot;A String&quot;, # Immutable. The fully qualified resource name of the AlertPolicy.
      &quot;contactDetails&quot;: [ # Optional. The contact details for each alert policy.
        { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
          &quot;emailAddress&quot;: &quot;A String&quot;, # Optional. The email address of the contact.
        },
      ],
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code used for notifications
    },
    &quot;autoRenew&quot;: True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
    &quot;endDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
      &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
      &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
      &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    },
    &quot;freeTrial&quot;: True or False, # Optional. Whether the license config is for free trial.
    &quot;geminiBundle&quot;: True or False, # Output only. Whether the license config is for Gemini bundle.
    &quot;licenseCount&quot;: &quot;A String&quot;, # Required. Number of licenses purchased.
    &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
    &quot;startDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
      &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
      &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
      &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    },
    &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the license config.
    &quot;subscriptionTerm&quot;: &quot;A String&quot;, # Required. Subscription term.
    &quot;subscriptionTier&quot;: &quot;A String&quot;, # Required. Subscription tier information for the license config.
  },
}</pre>
</div>

</body></html>